All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class quicktime.std.qtcomponents.TimeCoder

java.lang.Object
   |
   +----quicktime.QTObject
           |
           +----quicktime.std.comp.ComponentIdentifier
                   |
                   +----quicktime.std.comp.Component
                           |
                           +----quicktime.std.movies.media.MediaHandler
                                   |
                                   +----quicktime.std.movies.media.VisualMediaHandler
                                           |
                                           +----quicktime.std.qtcomponents.TimeCoder

public final class TimeCoder
extends VisualMediaHandler
implements QuickTimeLib

Method Index

 o fromMedia(TimeCodeMedia)
This method allows you to obtain a reference to a media handler component.
 o getAtTime(int)
Determines the time code from the time code handler.
 o getCurrent()
Determines the time code from the time code handler at the current time value.
 o getDisplayOptions()
Returns the current display options for text by the TimeCoder.
 o getFlags()
Allows you to retrieve the timecode control flags.
 o getSourceRef(TimeCodeDescription)
Allows you to retrieve the source information from the time code media sample.
 o setDisplayOptions(TCTextOptions)
Sets the current display options for text by the TimeCoder.
 o setFlags(int, int)
Allows you to change the flags that affect how QT handles the timecode information.
 o setSourceRef(TimeCodeDescription, QTHandleRef)
Allows you to change the source information in the media sample.
 o timeCodeToString(TimeCodeDef, int)
Converts a time value into a string (HH:MM:SS:FF) - if the timecode uses a drop frame technique the separators are semi-colons (HH;MM;SS;FF).
 o timeCodeToString(TimeCodeDef, TimeCodeTime)
Converts a time value into a string (HH:MM:SS:FF) - if the timecode uses a drop frame technique the separators are semi-colons (HH;MM;SS;FF).
 o toFrameNumber(TimeCodeTime, TimeCodeDef)
Converts a time value into a frame number using specified definitions.
 o toTimeCode(int, TimeCodeDef)
Converts a frame number into a time value using specified definitions.

Methods

 o fromMedia
 public static TimeCoder fromMedia(TimeCodeMedia m) throws StdQTException
This method allows you to obtain a reference to a media handler component. This returns the handler that is the appropriate class for this particular media.

QuickTime::GetMediaHandler()

Returns:
a MediaHandler object for the media's media handler.
See Also:
getTimeCodeMediaHandler, getMediaHandler
 o getCurrent
 public TimeCodeInfo getCurrent() throws QTException
Determines the time code from the time code handler at the current time value.

QuickTime::TCGetCurrentTimeCode()

Returns:
The information object containing the time code, its definition, and data.
 o getAtTime
 public TimeCodeInfo getAtTime(int mediaTime) throws QTException
Determines the time code from the time code handler.

QuickTime::TCGetTimeCodeAtTime()

Parameters:
mediaTime - The time value of the media at which to retrieve the time code information.
Returns:
The information object containing the time code, its definition, and data.
 o timeCodeToString
 public String timeCodeToString(TimeCodeDef tcdef,
                                TimeCodeTime tct) throws StdQTException
Converts a time value into a string (HH:MM:SS:FF) - if the timecode uses a drop frame technique the separators are semi-colons (HH;MM;SS;FF).

QuickTime::TCTimeCodeToString()

Parameters:
tcdef - the time code definition structure used for the conversion
tct - the time code time structure used for the conversion
Returns:
the converted string
 o timeCodeToString
 public String timeCodeToString(TimeCodeDef tcdef,
                                int counter) throws StdQTException
Converts a time value into a string (HH:MM:SS:FF) - if the timecode uses a drop frame technique the separators are semi-colons (HH;MM;SS;FF).

QuickTime::TCTimeCodeToString()

Parameters:
tcdef - the time code definition structure used for the conversion
counter - the time code counter value
Returns:
the converted string
 o toFrameNumber
 public int toFrameNumber(TimeCodeTime tcrec,
                          TimeCodeDef tcdef) throws StdQTException
Converts a time value into a frame number using specified definitions.

QuickTime::TCTimeCodeToFrameNumber()

Parameters:
tcrec - The time code value structure to convert.
tcdef - The time code definition object used for the conversion.
Returns:
The frame number.
 o toTimeCode
 public TimeCodeTime toTimeCode(int frameNumber,
                                TimeCodeDef tcdef) throws StdQTException
Converts a frame number into a time value using specified definitions.

QuickTime::TCFrameNumberToTimeCode()

Parameters:
frameNumber - The frame number to convert.
tcdef - The time code definition object used for the conversion.
Returns:
The time code value structure.
 o getSourceRef
 public QTHandle getSourceRef(TimeCodeDescription tcd) throws QTException
Allows you to retrieve the source information from the time code media sample.

QuickTime::TCGetSourceRef()

Parameters:
tcd - the description that describes the time code reference to be changed
Returns:
the source information that is found in the sample reference
 o setSourceRef
 public void setSourceRef(TimeCodeDescription tcd,
                          QTHandleRef sref) throws StdQTException
Allows you to change the source information in the media sample.

QuickTime::TCSetSourceRef()

Parameters:
tcd - the description that describes the time code reference to be changed
sref - the source information that is placed in the sample reference
 o setFlags
 public void setFlags(int flags,
                      int flagsMask) throws StdQTException
Allows you to change the flags that affect how QT handles the timecode information.

QuickTime::TCSetTimeCodeFlags()

Parameters:
flags - specifies the new flag value
flagsMask - specifies which of the flag values are to change.
 o getFlags
 public int getFlags() throws StdQTException
Allows you to retrieve the timecode control flags.

QuickTime::TCGetTimeCodeFlags()

Returns:
the timecode control flags
 o setDisplayOptions
 public void setDisplayOptions(TCTextOptions textOptions) throws StdQTException
Sets the current display options for text by the TimeCoder.

QuickTime::TCSetDisplayOptions()

Parameters:
textOptions - text display options
 o getDisplayOptions
 public TCTextOptions getDisplayOptions() throws StdQTException
Returns the current display options for text by the TimeCoder.

QuickTime::TCGetDisplayOptions()

Returns:
text display options

All Packages  Class Hierarchy  This Package  Previous  Next  Index